vcMessageService

vcMessageService is a service for managing messages in the application. It provides methods to add messages, clear messages, and handle message scopes.

See in: Overview

Module: vcCore

Parent: -

Children -

Referenced by: vcApplication.MessageService

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

Name	Type	Access	Description
Messages	list	R	Gets the list of messages in the message context.
MonospaceFontFamily	String	R	Gets the application's default monospace font family.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

Name	Return Type	Parameters	Description
addDebug	None	Exception exception	Adds a debug message with an exception to the message context. See more Parameters: exception (vcException): The Python exception instance to create the message from.
addDebug	None	String header, Exception exception	Adds a debug message with an exception to the message context. See more Parameters: exception (vcException): The Python exception instance to create the message from.
addDebug	None	vcLocalizable localizable	Adds a debug message with a localizable text to the message context. See more Parameters: localizable (vcLocalizable): The localizable text instance containing the localization key and format arguments.
addDebug	None	String message	Adds a debug message to the message context. See more Parameters: message (str): The text of the message. args (*args): Variable length argument list for formatting the message.
addError	None	Exception exception	Adds an error message with an exception to the message context. See more Parameters: exception (vcException): The Python exception instance to create the message from.
addError	None	String header, Exception exception	Adds an error message with an exception to the message context. See more Parameters: header (str): Header for the message. exception (vcException): The Python exception instance to create the message from.
addError	None	vcLocalizable localizable	Adds an error message with a localizable text to the message context. See more Parameters: localizable (vcLocalizable): The localizable text instance containing the localization key and format arguments.
addError	None	String message	Adds an error message to the message context. See more Parameters: message (str): The text of the message. args (*args): Variable length argument list for formatting the message.
addInfo	None	Exception exception	Adds an info message with an exception to the message context. See more Parameters: exception (vcException): The Python exception instance to create the message from.
addInfo	None	String header, Exception exception	Adds an info message with an exception to the message context. See more Parameters: header (str): Header for the message. exception (vcException): The Python exception instance to create the message from.
addInfo	None	vcLocalizable localizable	Adds an info message with a localizable text to the message context. See more Parameters: localizable (vcLocalizable): The localizable text instance containing the localization key and format arguments.
addInfo	None	String message	Adds an info message to the message context. See more Parameters: message (str): The text of the message. args (*args): Variable length argument list for formatting the message.
addMessage	None	vcMessage message	Adds a pre-constructed message to the message context. Parameters: message (vcMessage): The message to be added.
addWarning	None	Exception exception	Adds a warning message with an exception to the message context. See more Parameters: exception (vcException): The Python exception instance to create the message from.
addWarning	None	String header, Exception exception	Adds a warning message with an exception to the message context. See more Parameters: header (str): Header for the message. exception (vcException): The Python exception instance to create the message from.
addWarning	None	vcLocalizable localizable	Adds a warning message with a localizable text to the message context. See more Parameters: localizable (vcLocalizable): The localizable text instance containing the localization key and format arguments.
addWarning	None	String message	Adds a warning message to the message context. See more Parameters: message (str): The text of the message. args (*args): Variable length argument list for formatting the message.
clearMessages	None	None	Clears all messages from the message context.
createScope	vcMessageScope	String text, Optional Keyword[fontFamily = String]	Creates a new message scope with the specified text and font family. See more Parameters: text (str): The text to be displayed in the message scope. fontFamily (str): The font family to be used for the message scope. Defaults to an empty string. Returns: vcMessageScope: A new message scope instance.

Events

Learn how to use events here. The events are also inherited from the parent class.

Name	Parameters	Description
OnMessageAdded	vcMessage message	This event is triggered when a new message is added to the message context. See more Note, any new message added within the event handler will not trigger the event, but will be available as part of vcMessageService.Messages. Parameters: message (vcMessage): The added message.
OnMessagesCleared	None	This event is triggered when all messages are cleared from the message context.